Changes between Version 7 and Version 8 of Development FAQ

Timestamp:

Apr 28, 2007, 1:45:55 AM (17 years ago)

Author:

John Bailey

Comment:

Typo, grammar, and quoting fixes

Development FAQ

@@ -1 @@
-== There needs to be an easy way to linkify the functions names below to our doxygen documentations. ==
-
 = ["Development FAQ"] =
+The following is a list of Frequently Asked Questions (FAQs), with answers, and notes related to development using !LibPurple.  (Note for developers: There needs to be an easy way to linkify the functions names below to our doxygen documentations.
 
 [[TOC(inline,noheading)]]
 
 == Accounts ==
-=== I created an account. But it's not being saved. ===
-You need to use purple_accounts_add to add the account to the list of available accounts. This list of accounts is saved. Note that many of the functions require an account to be on that list. So you should always call purple_accounts_add after creating an account.
+=== I created an account, but it's not being saved! ===
+You need to use `purple_accounts_add()` to add the account to the list of available accounts. This list of accounts is saved. Note that many of the functions require an account to be on that list. So you should always call `purple_accounts_add()` after creating an account.
 
 === How do I get online with an account? ===
 There are two ways you can do this:
- * If you have other accounts online, and you want the new account to have the same status as those, then call purple_savedstatus_get_current to get the current status, and use gaim_savedstatus_activate_for_account for the account.
- * Otherwise, you can simply do purple_account_set_status to set the status of the account.
-An account needs to be enabled before it can be connected. So after doing either of the above, you need to enable the account by calling purple_account_set_enabled.
+ * If you have other accounts online, and you want the new account to have the same status as those, then call `purple_savedstatus_get_current()` to get the current status, and use `purple_savedstatus_activate_for_account()` for the account.
+ * Otherwise, you can simply do `purple_account_set_status()` to set the status of the account.
+An account needs to be enabled before it can be connected. So after doing either of the above, you need to enable the account by calling `purple_account_set_enabled()`.
 
 
 == Conversations ==
 === How can I create a conversation with someone? ===
-Use purple_conversation_new. Use PURPLE_CONV_TYPE_IM if the conversation is an IM (one-to-one person conversation), and use PURPLE_CONV_TYPE_CHAT if it's a multi-user conversation. One important thing to note here is that the name-property of the PurpleConversation struct is the name of the buddy you are creating a conversation with (the documentation states that this is the name of the conversation itself, but it is in fact also the name of the receiver buddy). So a call to purple_conversation_new takes the name of the buddy as its third argument.
+Use `purple_conversation_new()`. Use `PURPLE_CONV_TYPE_IM` if the conversation is an IM (one-to-one person conversation), and use `PURPLE_CONV_TYPE_CHAT` if it's a multi-user conversation. One important thing to note here is that the name property of the `PurpleConversation` struct is the name of the buddy you are creating a conversation with (the documentation states that this is the name of the conversation itself, but it is in fact also the name of the receiving buddy). So a call to `purple_conversation_new()` takes the name of the buddy as its third argument.
 
 === How can I send a message in a conversation? ===
-Use either purple_conv_im_send or purple_conv_chat_send. Note that the first parameter to either of these functions are '''not''' the conversation itself. Rather, it's the im-data/chat-data of the conversation which you can get from PURPLE_CONV_IM/PURPLE_CONV_CHAT.
+Use either `purple_conv_im_send()` or `purple_conv_chat_send()`. Note that the first parameter to either of these functions are '''not''' the conversation itself. Rather, it's the IM data or chat data of the conversation which you can get from `PURPLE_CONV_IM`/`PURPLE_CONV_CHAT`.
 
 === Is there a way that I can print something in the conversation window, but not send the message? ===
-Yes. Use purple_conv_im_write/purple_conv_chat_write.
+Yes. Use `purple_conv_im_write()` or `purple_conv_chat_write()`.
 
 == Files and File Paths ==
@@ -49 +48 @@
 
 === Should I use `snprintf()` or `vsnprintf()`? ===
-No.  Use the GLib wrapper functions instead.  They are `g_snprintf()` and `g_vsnprintf`.
+No.  Use the GLib wrapper functions instead.  They are `g_snprintf()` and `g_vsnprintf()`.
 
 === How do I get the settings directory? ===